Retrieve or Create Service Criteria Records
Introduction
The Assetic REST API endpoints allow for the retrieval and creation of Service Criteria records associated with components. These API endpoints allow for the synchronisation of service criteria condition data stemming from assessments with external applications.
The following endpoints are available for Service Criteria records:
-
GET /api/v2/servicecriteria/score
-
GET /api/v2/servicecriteria/score/{id}
-
POST /api/v2/servicecriteria
Please read the article Asset Integration Overview if it is unclear how these endpoints relate to the asset structure in Assetic.
Additionally, the article How to Add Custom Service Criteria covers the process of how to review pre-configured Service Criteria for each Brightly Assetic asset category, and how additional custom service can be created for a Component Types if required.
Reviewing which Service Criteria are available for a Component Types is important in the context of creating new records, as the Name of the Service Criteria configuration is required as part of the POST payload. As an alternative approach, the existing Service Criteria that are available for a component can be seen when viewing it directly, within the Assessments – Service Criteria tab. The Service Criteria article shows an example of how this can be accessed after selecting a component.
Service Criteria can be loaded in bulk using the Data Exchange module (Module: Assessments, Category: Service Criteria). The process described in Data Exchange Integration should be used for data migration projects or large volume transactions.
GET /api/v2/servicecriteria/score
The Assetic REST API endpoint ‘GET /api/v2/servicecriteria/score’ is used to get a paginated collection of Service Criteria scores. Typically, a search filter is applied to restrict the list of scores returned, such as to a specific asset, component, service criteria type, or even a combination of these. The article Search Filters and Pagination describes the correct syntax to use when applying search filtering and a sort order.
Sample Request
https://XXX.assetic.net/api/v2/servicecriteria/score
Sample Response
{
"TotalResults": 1,
"TotalPages": 1,
"Page": 1,
"ResourceList": [
{
"Id": 58837,
"AssessmentDate": "2026-01-01T00:00:00,
"Score": 3,
"CreatedDate": "2026-01-01T13:39:30",
"IsMostRecentScore": true,
"AssetCategory": "Roads",
"AssetCategoryId": "246da33d-6544-e411-82fb-f4b7e2cd8977",
"AssetId": "ROAD733861",
"ComponentId": "CP01122497",
"AssessedByResourceId": "4df901f8-b80c-47cc-97c0-142d46dd43fb",
"AssessedByResourceName": "John Smith",
"ServiceCriteriaTypeId": "3d1e03b8-2d70-427e-b3b0-6a45b0ce53b6",
"ServiceCriteriaTypeLabel": "Consequence",
"ServiceCriteriaTypeGroup": "Risk",
"_links": [],
"_embedded": null
}
],
"_links": [],
"_embedded": null
}
GET /api/v2/servicecriteria/score/{id}
The Assetic REST API endpoint ‘GET /api/v2/servicecriteria/score/{id}’ retrieves a single Service Criteria score, where {id} is the unique ‘Id’ identifier for an existing score that is being retrieved.
This API endpoint is typically used when the ‘Id’ has been recorded in an external application, so that a specific Service Criteria score’s details can be retrieved without the requirement of filtering. If the unique identifier for a score is unknown then the endpoint ‘GET /api/v2/servicecriteria/score’ may be first used with a search filter to retrieve a paginated list of scores, filtered based on an asset or a component. This endpoint is documented in an above section of this same article.
Sample Request
https://XXX.assetic.net/api/v2/servicecriteria/score/58839
Sample Response
{
"Id": 58839,
"AssessmentDate": "2026-01-04T00:00:00",
"Score": 2.5,
"CreatedDate": "2026-01-04T13:50:43",
"IsMostRecentScore": false,
"AssetCategory": "Intersections",
"AssetCategoryId": "106da33d-6544-e411-82fb-f4b7e2cd8977",
"AssetId": "INT60966",
"ComponentId": "CP91266",
"AssessedByResourceId": "4df901f8-b80c-47cc-97c0-142d46dd43fb",
"AssessedByResourceName": "Sally Williams",
"ServiceCriteriaTypeId": "8bf19bbb-c654-e411-8305-f4b7e2cd8977",
"ServiceCriteriaTypeLabel": "Infill Condition",
"ServiceCriteriaTypeGroup": "Condition",
"_links": [],
"_embedded": null
}
POST /api/v2/servicecriteria
The Assetic REST API endpoint ‘POST /api/v2/servicecriteria’ may be used to create a new Service Criteria score record, against a specified component.
When creating a new service criteria score the following properties are relevant:
|
Property |
Description |
Type |
Sample |
|
AssessmentDate |
The assessment date that the service criteria score corresponds to. |
DateTime |
"AssessmentDate": "2026-01-20T23:03:44.817Z" |
|
Score |
A Decimal score value for the service criteria within the range of 0-6, where 0 is new a 6 is end of life.
Scores with a decimal precision greater than 2 will appear rounded within the Brightly Assetic user interface. |
Decimal |
"Score": 1.0 |
|
ComponentId |
The user-friendly Component Id that the Service Criteria score will score will be applied to. |
String |
"ComponentId": "CP128932" |
|
AssessedByResourceName |
The Display Name of a Brightly Assetic Resource.
See the Get Resources article for additional information on retrieving resource details. |
String |
"AssessedByResourceName": "Sally Williams" |
|
ServiceCriteriaTypeLabel |
The user-friendly name of the Service Criteria Type that the score relates to.
See the How to Add Custom Service Criteria article for additional information on viewing available Service Criteria for a Component Type within an asset category. |
String |
"ServiceCriteriaTypeLabel": "Superstructure Condition" |
Sample Request
{
"AssessmentDate": "2026-01-20T23:03:44.817Z",
"Score": 1.0,
"ComponentId": "CP128932",
"AssessedByResourceName": "Sally Williams",
"ServiceCriteriaTypeLabel": "Superstructure Condition"
}
Sample Response
{
"Data": [
{
"Id": 58846,
"AssessmentDate": "2026-01-20T23:03:44",
"Score": 1.0,
"CreatedDate": "2026-01-21T11:08:39",
"IsMostRecentScore": true,
"AssetCategory": "Buildings",
"AssetCategoryId": "df6ca33d-6544-e411-82fb-f4b7e2cd8977",
"AssetId": "BLD123456",
"ComponentId": "CP128932",
"AssessedByResourceId": "66554e3b-ed60-4036-8552-1cdac380fffb",
"AssessedByResourceName": "Sally Williams",
"ServiceCriteriaTypeId": "f3f19bbb-c654-e411-8305-f4b7e2cd8977",
"ServiceCriteriaTypeLabel": "Superstructure Condition",
"ServiceCriteriaTypeGroup": "Condition",
"_links": [],
"_embedded": null
}
],
"Total": 1,
"AggregateResults": null,
"Errors": null
}
